Auth0 Python SDK v5.0.0b0

⚠️ BREAKING CHANGES - Major Rewrite

This is a beta release of the upcoming major version. It introduces breaking changes, particularly in the Management API client. Please refer to the v5 Migration Guide for detailed upgrade instructions.

✍️ What's New

• ✨ OpenAPI-Generated: Complete rewrite generated from Auth0's OpenAPI specifications using Fern
• 📦 Better Organization: Hierarchical package structure with logical sub-clients for improved discoverability
• 🔒 Type Safety: Strongly typed request/response objects using Pydantic replace generic dictionaries
• ✨ Enhanced Developer Experience: Better IntelliSense, code completion, and documentation
• 🚀 Future-Proof: Easier maintenance and updates as Auth0's API evolves
• ⚡ Async Support: First-class async client with AsyncAuth0 and AsyncManagementClient
• 📄 Automatic Pagination: Built-in pagination support with include_totals=True by default

💥 Breaking Changes

Python Version Support

• The SDK now requires Python ≥3.8
• Support for Python 3.7 has been dropped

Management API Client Redesign

• The Management API client has been fully restructured using Fern for code generation
• Methods are now organized into modular sub-clients, improving structure and maintainability
• Method names and signatures have changed, adopting consistent and predictable naming conventions
• Pagination defaults changed: include_totals=True is now the default for list operations
• These changes are not backward compatible with the v4.x client

Import Changes

📝 Quick Migration Example

Before (v4.x):

from auth0.management import Auth0

# Initialize with full base URL
mgmt_api = Auth0(
    domain='YOUR_DOMAIN.auth0.com',
    token='YOUR_TOKEN'
)

# List users with explicit pagination
users = mgmt_api.users.list(
    page=0,
    per_page=50,
    include_totals=True  # Must specify explicitly
)

# Generic dictionary responses
for user in users['users']:
    print(user['email'])

After (v5.0.0):

from auth0.management import ManagementClient

# Simpler initialization - just domain
client = ManagementClient(
    domain='YOUR_DOMAIN.auth0.com',
    token='YOUR_TOKEN'
)

# Or with automatic token management
client = ManagementClient(
    domain='YOUR_DOMAIN.auth0.com',
    client_id='YOUR_CLIENT_ID',
    client_secret='YOUR_CLIENT_SECRET'
)

# Pagination with include_totals=True by default
response = client.users.list(
    page=0,
    per_page=50
)

# Strongly-typed Pydantic models
for user in response.users:
    print(user.email)  # Type-safe attribute access

🔧 Migration Steps

1. Update imports: Change import paths as shown in the table above
2. Client initialization: Use ManagementClient with just domain instead of full base_url
3. Update method calls: Review method signatures - many have changed for consistency
4. Handle responses: Access response data as attributes (Pydantic models) instead of dictionary keys
5. Error handling: Catch ApiError instead of Auth0Error for Management API errors
6. Pagination: include_totals now defaults to True - adjust if you relied on False
7. Async support: Use AsyncManagementClient or AsyncAuth0 for async operations

✅ What's NOT Affected

The authentication package remains fully compatible! All authentication APIs work the same way between v4.x and v5.0.0:

• ✅ GetToken - Client credentials, authorization code flows
• ✅ Database - User signup and authentication
• ✅ Passwordless - Passwordless authentication
• ✅ Users - User authentication operations
• ✅ Token verification and validation

📚 Resources

• Migration Guide: Detailed migration instructions
• API Reference: Complete API documentation
• README: Updated examples and usage guide

⚠️ Beta Release

This is a beta release. While core functionality is stable, minor API adjustments may occur before the final v5.0.0 release. Please test thoroughly and provide feedback!

📦 Installation

pip install auth0-python==5.0.0b0

Or add to your requirements.txt:

auth0-python>=5.0.0b0,<6.0.0